/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.client.gui.action;

import java.awt.event.ActionEvent;

import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.common.model.Player;


/**
 * An action for retiring from the game.
 */
public class RetireAction extends FreeColAction
{

    public static final String id = "retireAction";


    /**
     * Creates a new <code>RetireAction</code>.
     *
     * @param freeColClient The <code>FreeColClient</code> for the game.
     */
    public RetireAction( FreeColClient freeColClient )
    {
        super( freeColClient, id );
    }


    // Override FreeColAction

    /**
     * {@inheritDoc}
     */
    @Override
    protected boolean shouldBeEnabled( )
    {
        Player player = freeColClient.getMyPlayer( );
        return super.shouldBeEnabled( )
                && player != null
                && player.getPlayerType( ) != Player.PlayerType.RETIRED;
    }


    // Interface ActionListener

    /**
     * {@inheritDoc}
     */
    @Override
    public void actionPerformed( ActionEvent ae )
    {
        freeColClient.retire( );
    }
}
